# eric7.Plugins.VcsPlugins.vcsMercurial.PurgeBuiltin.purge

Module implementing the purge extension interface.

### Global Attributes

None

### Classes

Purge | Class implementing the purge extension interface.

### Functions

None

## Purge

Class implementing the purge extension interface.

### Derived from

HgExtension

### Class Attributes

None

### Class Methods

None

### Methods

Purge | Constructor
__getEntries | Private method to get a list of files/directories about to be purged.
hgPurge | Public method to purge files and directories not tracked by Mercurial.
hgPurgeList | Public method to list files and directories not tracked by Mercurial.
shutdown | Public method used to shutdown the purge interface.

### Static Methods

None

#### Purge (Constructor)

Purge(vcs, ui=None)

Constructor

vcs (Hg)
  reference to the Mercurial vcs object
ui (QWidget)
  reference to a UI widget (defaults to None)

#### Purge.__getEntries

__getEntries(deleteAll, ignoredOnly)

Private method to get a list of files/directories about to be purged.

deleteAll (bool)
  flag indicating to delete all files including ignored ones
ignoredOnly (bool)
  flag indicating to delete ignored files only

Return:
  name of the current patch

Return Type:
  str

#### Purge.hgPurge

hgPurge(deleteAll=False, ignoredOnly=False)

Public method to purge files and directories not tracked by Mercurial.

deleteAll (bool (optional))
  flag indicating to delete all files including ignored ones (defaults to False)
ignoredOnly (bool (optional))
  flag indicating to delete ignored files only (defaults to False)

#### Purge.hgPurgeList

hgPurgeList(deleteAll=False, ignoredOnly=False)

Public method to list files and directories not tracked by Mercurial.

deleteAll (bool (optional))
  flag indicating to delete all files including ignored ones (defaults to False)
ignoredOnly (bool (optional))
  flag indicating to delete ignored files only (defaults to False)

#### Purge.shutdown

shutdown()

Public method used to shutdown the purge interface.

Up